home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / sgml / gimpguides.sgml < prev    next >
Encoding:
Text File  |  2003-05-20  |  8.6 KB  |  215 lines
  1. <refentry id="libgimp-gimpguides" revision="19 Jan 2001">
  2. <refmeta>
  3. <refentrytitle>gimpguides</refentrytitle>
  4. <manvolnum>3</manvolnum>
  5. <refmiscinfo>LIBGIMP Library</refmiscinfo>
  6. </refmeta>
  7.  
  8. <refnamediv>
  9. <refname>gimpguides</refname><refpurpose></refpurpose>
  10. </refnamediv>
  11.  
  12. <refsynopsisdiv><title>Synopsis</title>
  13. <synopsis>
  14.  
  15.  
  16.  
  17. <link linkend="gint32">gint32</link>      <link linkend="gimp-image-add-hguide">gimp_image_add_hguide</link>           (<link linkend="gint32">gint32</link> image_ID,
  18.                                              <link linkend="gint">gint</link> yposition);
  19. <link linkend="gint32">gint32</link>      <link linkend="gimp-image-add-vguide">gimp_image_add_vguide</link>           (<link linkend="gint32">gint32</link> image_ID,
  20.                                              <link linkend="gint">gint</link> xposition);
  21. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-image-delete-guide">gimp_image_delete_guide</link>         (<link linkend="gint32">gint32</link> image_ID,
  22.                                              <link linkend="gint32">gint32</link> guide_ID);
  23. <link linkend="gint32">gint32</link>      <link linkend="gimp-image-find-next-guide">gimp_image_find_next_guide</link>      (<link linkend="gint32">gint32</link> image_ID,
  24.                                              <link linkend="gint32">gint32</link> guide_ID);
  25. <link linkend="GimpOrientationType">GimpOrientationType</link> <link linkend="gimp-image-get-guide-orientation">gimp_image_get_guide_orientation</link>
  26.                                             (<link linkend="gint32">gint32</link> image_ID,
  27.                                              <link linkend="gint32">gint32</link> guide_ID);
  28. <link linkend="gint">gint</link>        <link linkend="gimp-image-get-guide-position">gimp_image_get_guide_position</link>   (<link linkend="gint32">gint32</link> image_ID,
  29.                                              <link linkend="gint32">gint32</link> guide_ID);
  30. </synopsis>
  31. </refsynopsisdiv>
  32.  
  33.  
  34.  
  35.  
  36.  
  37. <refsect1>
  38. <title>Description</title>
  39. <para>
  40.  
  41. </para>
  42. </refsect1>
  43.  
  44. <refsect1>
  45. <title>Details</title>
  46. <refsect2>
  47. <title><anchor id="gimp-image-add-hguide">gimp_image_add_hguide ()</title>
  48. <programlisting><link linkend="gint32">gint32</link>      gimp_image_add_hguide           (<link linkend="gint32">gint32</link> image_ID,
  49.                                              <link linkend="gint">gint</link> yposition);</programlisting>
  50. <para>
  51. Add a horizontal guide to an image.
  52. </para>
  53. <para>
  54. This procedure adds a horizontal guide to an image. It takes the
  55. input image and the y-position of the new guide as parameters. It
  56. returns the guide ID of the new guide.</para>
  57. <para>
  58.  
  59. </para><informaltable pgwide=1 frame="none" role="params">
  60. <tgroup cols="2">
  61. <colspec colwidth="2*">
  62. <colspec colwidth="8*">
  63. <tbody>
  64. <row><entry align="right"><parameter>image_ID</parameter> :</entry>
  65. <entry> The image.
  66. </entry></row>
  67. <row><entry align="right"><parameter>yposition</parameter> :</entry>
  68. <entry> The guide's y-offset from top of image.
  69. </entry></row>
  70. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The new guide.
  71. </entry></row>
  72. </tbody></tgroup></informaltable></refsect2>
  73. <refsect2>
  74. <title><anchor id="gimp-image-add-vguide">gimp_image_add_vguide ()</title>
  75. <programlisting><link linkend="gint32">gint32</link>      gimp_image_add_vguide           (<link linkend="gint32">gint32</link> image_ID,
  76.                                              <link linkend="gint">gint</link> xposition);</programlisting>
  77. <para>
  78. Add a vertical guide to an image.
  79. </para>
  80. <para>
  81. This procedure adds a vertical guide to an image. It takes the input
  82. image and the x-position of the new guide as parameters. It returns
  83. the guide ID of the new guide.</para>
  84. <para>
  85.  
  86. </para><informaltable pgwide=1 frame="none" role="params">
  87. <tgroup cols="2">
  88. <colspec colwidth="2*">
  89. <colspec colwidth="8*">
  90. <tbody>
  91. <row><entry align="right"><parameter>image_ID</parameter> :</entry>
  92. <entry> The image.
  93. </entry></row>
  94. <row><entry align="right"><parameter>xposition</parameter> :</entry>
  95. <entry> The guide's x-offset from left of image.
  96. </entry></row>
  97. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The new guide.
  98. </entry></row>
  99. </tbody></tgroup></informaltable></refsect2>
  100. <refsect2>
  101. <title><anchor id="gimp-image-delete-guide">gimp_image_delete_guide ()</title>
  102. <programlisting><link linkend="gboolean">gboolean</link>    gimp_image_delete_guide         (<link linkend="gint32">gint32</link> image_ID,
  103.                                              <link linkend="gint32">gint32</link> guide_ID);</programlisting>
  104. <para>
  105. Deletes a guide from an image.
  106. </para>
  107. <para>
  108. This procedure takes an image and a guide ID as input and removes
  109. the specified guide from the specified image.</para>
  110. <para>
  111.  
  112. </para><informaltable pgwide=1 frame="none" role="params">
  113. <tgroup cols="2">
  114. <colspec colwidth="2*">
  115. <colspec colwidth="8*">
  116. <tbody>
  117. <row><entry align="right"><parameter>image_ID</parameter> :</entry>
  118. <entry> The image.
  119. </entry></row>
  120. <row><entry align="right"><parameter>guide_ID</parameter> :</entry>
  121. <entry> The ID of the guide to be removed.
  122. </entry></row>
  123. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  124. </entry></row>
  125. </tbody></tgroup></informaltable></refsect2>
  126. <refsect2>
  127. <title><anchor id="gimp-image-find-next-guide">gimp_image_find_next_guide ()</title>
  128. <programlisting><link linkend="gint32">gint32</link>      gimp_image_find_next_guide      (<link linkend="gint32">gint32</link> image_ID,
  129.                                              <link linkend="gint32">gint32</link> guide_ID);</programlisting>
  130. <para>
  131. Find next guide on an image.
  132. </para>
  133. <para>
  134. This procedure takes an image and a guide ID as input and finds the
  135. guide ID of the successor of the given guide ID in the image's guide
  136. list. If the supplied guide ID is 0, the procedure will return the
  137. first Guide. The procedure will return 0 if given the final guide ID
  138. as an argument or the image has no guides.</para>
  139. <para>
  140.  
  141. </para><informaltable pgwide=1 frame="none" role="params">
  142. <tgroup cols="2">
  143. <colspec colwidth="2*">
  144. <colspec colwidth="8*">
  145. <tbody>
  146. <row><entry align="right"><parameter>image_ID</parameter> :</entry>
  147. <entry> The image.
  148. </entry></row>
  149. <row><entry align="right"><parameter>guide_ID</parameter> :</entry>
  150. <entry> The ID of the current guide (0 if first invocation).
  151. </entry></row>
  152. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The next guide's ID.
  153. </entry></row>
  154. </tbody></tgroup></informaltable></refsect2>
  155. <refsect2>
  156. <title><anchor id="gimp-image-get-guide-orientation">gimp_image_get_guide_orientation ()</title>
  157. <programlisting><link linkend="GimpOrientationType">GimpOrientationType</link> gimp_image_get_guide_orientation
  158.                                             (<link linkend="gint32">gint32</link> image_ID,
  159.                                              <link linkend="gint32">gint32</link> guide_ID);</programlisting>
  160. <para>
  161. Get orientation of a guide on an image.
  162. </para>
  163. <para>
  164. This procedure takes an image and a guide ID as input and returns
  165. the orientations of the guide.</para>
  166. <para>
  167.  
  168. </para><informaltable pgwide=1 frame="none" role="params">
  169. <tgroup cols="2">
  170. <colspec colwidth="2*">
  171. <colspec colwidth="8*">
  172. <tbody>
  173. <row><entry align="right"><parameter>image_ID</parameter> :</entry>
  174. <entry> The image.
  175. </entry></row>
  176. <row><entry align="right"><parameter>guide_ID</parameter> :</entry>
  177. <entry> The guide.
  178. </entry></row>
  179. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The guide's orientation.
  180. </entry></row>
  181. </tbody></tgroup></informaltable></refsect2>
  182. <refsect2>
  183. <title><anchor id="gimp-image-get-guide-position">gimp_image_get_guide_position ()</title>
  184. <programlisting><link linkend="gint">gint</link>        gimp_image_get_guide_position   (<link linkend="gint32">gint32</link> image_ID,
  185.                                              <link linkend="gint32">gint32</link> guide_ID);</programlisting>
  186. <para>
  187. Get position of a guide on an image.
  188. </para>
  189. <para>
  190. This procedure takes an image and a guide ID as input and returns
  191. the position of the guide relative to the top or left of the image.</para>
  192. <para>
  193.  
  194. </para><informaltable pgwide=1 frame="none" role="params">
  195. <tgroup cols="2">
  196. <colspec colwidth="2*">
  197. <colspec colwidth="8*">
  198. <tbody>
  199. <row><entry align="right"><parameter>image_ID</parameter> :</entry>
  200. <entry> The image.
  201. </entry></row>
  202. <row><entry align="right"><parameter>guide_ID</parameter> :</entry>
  203. <entry> The guide.
  204. </entry></row>
  205. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The guide's position relative to top or left of image.
  206. </entry></row>
  207. </tbody></tgroup></informaltable></refsect2>
  208.  
  209. </refsect1>
  210.  
  211.  
  212.  
  213.  
  214. </refentry>
  215.